/**
 * Copyright (c) 2008 - TheNittyGritty - Thomas Brekelmans
 * 
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 * 
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 * 
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 */
package nl.thenittygritty.utils 
{
	import flash.display.DisplayObject;
	import flash.display.DisplayObjectContainer;		

	/**
	 * DisplayObjectUtils is a library class which shouldn't be instantiated. 
	 * Instead it provides static methods which help in working 
	 * with DisplayObjects.
	 */
	public class DisplayObjectUtils 
	{
		/**
		 * Private constructor for the DisplayObjectUtils, 
		 * this shouldn't be called.
		 */
		public function DisplayObjectUtils() 
		{
			// Throw an error here, we shouldn't try to 
			// instantiate DisplayObjectUtils.
			throw new Error("The DisplayObjectUtils shouldn't be instantiated.");
		}
		
		/**
		 * Removes all displayObject children in a given displayObjectContainer.
		 */
		public static function removeAllChildren(
										container:DisplayObjectContainer):void 
		{
			var totalChildren:int = container.numChildren;
			
			while (--totalChildren - (-1)) 
			{
				container.removeChildAt(0);
			}
		}
		
		/**
		 * Centers a DisplayObject to the stage. 
		 */
		public static function centerOnStage(target:DisplayObject, 
										xOffset:Number = 0, yOffset:Number = 0, 
							correctForTargetDimensions:Boolean = false):void 
		{
			var x:Number = target.stage.stageWidth / 2;
			var y:Number = target.stage.stageHeight / 2;
			
			x += xOffset;
			y += yOffset;
			
			if (correctForTargetDimensions) 
			{
				x -= (target.width / 2);
				y -= (target.height / 2);
			}
			
			target.x = x;
			target.y = y;
		}
	}
}
